home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsISVGRendererCanvas.idl < prev    next >
Text File  |  2006-05-08  |  5KB  |  148 lines
  1. /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is the Mozilla SVG project.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Crocodile Clips Ltd.
  19.  * Portions created by the Initial Developer are Copyright (C) 2002
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41.  
  42. %{C++
  43. struct nsRect;
  44. %}
  45.  
  46. [ref] native nsRectRef(nsRect);
  47.  
  48. typedef PRUint32 nscolor;
  49.  
  50. interface nsIRenderingContext;
  51. interface nsPresContext;
  52. interface nsIDOMSVGMatrix;
  53. interface nsISVGRendererSurface;
  54.  
  55. /**
  56.  * \addtogroup renderer_interfaces Rendering Engine Interfaces
  57.  * @{
  58.  */
  59.  
  60. /**
  61.  * One of a number of interfaces (all starting with nsISVGRenderer*)
  62.  * to be implemented by an SVG rendering engine. See nsISVGRenderer
  63.  * for more details.
  64.  *
  65.  * This interface abstracts a rendering engine-native canvas object
  66.  * onto which path and glyph geometries can be painted.
  67.  *
  68.  * A canvas object is instantiated by the backend for a given
  69.  * Mozilla-native rendering object with a call to
  70.  * nsISVGRenderer::createCanvas().
  71.  */
  72. [scriptable, uuid(2e64a227-de4b-4a69-ab82-5dda1579e90f)]
  73. interface nsISVGRendererCanvas : nsISupports
  74. {
  75.   /**
  76.    * Lock a portion of the canvas and obtain a rendering context onto
  77.    * which Mozilla can paint non-svg content. This is needed for
  78.    * (partial) foreignObject support.
  79.    *
  80.    * lockRenderingContext() calls are paired with
  81.    * unlockRenderingContext() calls.
  82.    *
  83.    * @param rect Area to be locked.
  84.    * @return Mozilla-native rendering context for the locked area.
  85.    */
  86.   [noscript] nsIRenderingContext lockRenderingContext([const] in nsRectRef rect);
  87.  
  88.   /**
  89.    * Unlock the canvas portion locked with a previous call to
  90.    * lockRenderingContext(). 
  91.    */
  92.   void unlockRenderingContext();
  93.  
  94.   // XXX do we need this?
  95.   nsPresContext getPresContext();
  96.  
  97.   /**
  98.    * Fill the canvas with the given color.
  99.    *
  100.    * @param color Fill color.
  101.    */
  102.   void clear(in nscolor color);
  103.  
  104.   /**
  105.    * Ensure that all renderings on the canvas have been flushed to the
  106.    * Mozilla-native rendering context.
  107.    */
  108.   void flush();
  109.  
  110.   /**
  111.    * Set render mode (clipping or normal draw)
  112.    */
  113.   const unsigned short SVG_RENDER_MODE_NORMAL = 0;
  114.   const unsigned short SVG_RENDER_MODE_CLIP = 1;
  115.   attribute unsigned short renderMode;
  116.  
  117.   /**
  118.    * Push/Pop clip path.
  119.    */
  120.   void pushClip();
  121.   void popClip();
  122.  
  123.   /**
  124.    * Set rectangular clip region.
  125.    */
  126.   void setClipRect(in nsIDOMSVGMatrix canvasTM, in float x, in float y,
  127.                    in float width, in float height);
  128.  
  129.   /**
  130.    * Push/Pop surface as primary drawing surface.
  131.    */
  132.   void pushSurface(in nsISVGRendererSurface surface);
  133.   void popSurface();
  134.  
  135.   /**
  136.    * Surface composition.
  137.    */
  138.   void compositeSurface(in nsISVGRendererSurface surface,
  139.                         in unsigned long x, in unsigned long y,
  140.                         in float opacity);
  141.  
  142.   void compositeSurfaceMatrix(in nsISVGRendererSurface surface,
  143.                               in nsIDOMSVGMatrix canvasTM,
  144.                               in float opacity);
  145. };
  146.  
  147. /** @} */
  148.